home *** CD-ROM | disk | FTP | other *** search
/ Aminet 23 / Aminet 23 (1998)(GTI - Schatztruhe)[!][Feb 1998].iso / Aminet / util / boot / memclear2.lha / MemClear / MemClear.doc < prev    next >
Text File  |  1997-11-16  |  7KB  |  153 lines
  1. -----------------------------------------------------------------------
  2. ===========================  MemClear V 2.0  ==========================
  3. -----------------------------------------------------------------------
  4.  
  5.             MemClear © Copyright 1991-1994 by Ralf Thanner
  6.  
  7.                         © Copyright 1997 by Dave Jones
  8.  
  9.  
  10. -----------------------------------------------------------------------
  11. ================================= Author ==============================
  12. -----------------------------------------------------------------------
  13.  
  14. MemClear  V1.7  was written by Ralf Thanner using the Devpac assembler,
  15. the  original MemClear idea was suggested from MemClear by John Hodgson
  16. which had some substancial disadvantages.
  17.  
  18. V1.7  was  the  final  version  by Ralf, and unfortunatly, it caused an
  19. enforcer  hit  each  time  it cleared memory.  I mailed Ralf to get his
  20. permission  to  release a new fixed up version, but got no reply, which
  21. is unfortunate, as I would have preferred his approval.
  22.  
  23. I  also made some optimisations, and removed arp.library support, which
  24. means memclear is now Workbench 2.0+ only.
  25.  
  26. As  a  majority of this program is still the same, it only seemed right
  27. to retain as much of the original documentation as possible.
  28.  
  29. -----------------------------------------------------------------------
  30. ================================ Purpose ==============================
  31. -----------------------------------------------------------------------
  32.  
  33. MemClear  clears  the  unused memory chunks with zeros.  After clearing
  34. memory,  it  prints the amount of cleared bytes in CHIP and FAST MEMORY
  35. and the total amount of free bytes.
  36.  
  37. Due  to  the fact that MemClear will show you the amount of free memory
  38. and  the  largest  chunks  you  can  also  use  it instead of the Avail
  39. command.  It can also flush all currently unused devices, libraries and
  40. fonts from memory.  Memclear is pure, too, and for those reasons a good
  41. replacement for Avail.
  42.  
  43. If MemClear finds a difference between the real amount of bytes cleared
  44. and the value that is stored in Execbase a warning will be printed out.
  45. That  means  that  your  memory structure is defect, which was probably
  46. caused by a bugged program destroying the memory lists.
  47.  
  48. In  most  cases  your  Amiga  will  crash  sooner or later [next time a
  49. program uses FreeMem() or AllocMem()].  So if you read the warning it's
  50. the best you save all your current work and re-boot your machine.
  51.  
  52. -----------------------------------------------------------------------
  53. ========================= System Requirements =========================
  54. -----------------------------------------------------------------------
  55.  
  56. MemClear 2.0 works with all Kickstarts above v2.0 and all memory types.
  57.  
  58. -----------------------------------------------------------------------
  59. ================================ Usage ================================
  60. -----------------------------------------------------------------------
  61.  
  62.     MemClear cannot be started from Workbench, it is a Shell tool!
  63.  
  64.  
  65. The following commands are supported:
  66.  
  67.  
  68.         "AVAIL"   - Displays the free memory without clearing. Avail
  69.                     does NOT count the real free bytes. It is just a
  70.                     avail clone.
  71.  
  72.  
  73.         "FLUSH"   - Flushing all currently unused devices, libraries
  74.                     and fonts from memory.
  75.  
  76.                     NOTE:
  77.                     there  are  some bad written programs which destroy
  78.                     parts  of the internal memory lists. These programs
  79.                     WILL  cause a  crash  if memory is flushed (even if
  80.                     you  have already 'quitted' them!). You can test it
  81.                     for  yourself  with  the  CLI-commands flush and/or
  82.                     avail [FLUSH] from Commodore.
  83.  
  84.                     After  flushing memory MemClear will print how much
  85.                     more memory is free now.
  86.  
  87.  
  88.         "NoClear" - This  option is useful if you just want your memory
  89.                     flushed without clearing. Especially if you're using
  90.                     DynamiCache, this option will be very useful in case
  91.                     you just want to flush unused devices, fonts etc.
  92.  
  93.  
  94.         "QUIET"   - All actions will be performed silent.
  95.  
  96.  
  97. Following options are allowed:
  98.  
  99.  
  100.         "F"       - Fills only free fast-memory.
  101.  
  102.         "C"       - Fills only free chip-memory.
  103.  
  104.  
  105. If  you don't want the memory cleared, but rather be filled use a 'FILL
  106. VALUE' which is defined this way:
  107.  
  108.  
  109.         "-$FE"    - Fills memory with $fe instead of zeros. All
  110.                     hexadecimals  are allowed. One  single  hex
  111.                     value, e.g. '-$b' will be expanded to '$bb'. 
  112.  
  113.         "-A"      - Fills memory with  choosen  character. This
  114.                     option IS case sensitive.
  115.  
  116.  
  117. If  MemClear is invoked without any option it will simply fill the free
  118. memory with zeros and print the (real) free amount of memory. Real free
  119. memory means that this is not necessarily the amount of free memory the
  120. system  has stored in its memheader structure, but rather the amount of
  121. bytes encountered in the memory chunks.
  122.  
  123. You can combine fill pattern and area, but only one case sensitive char
  124. or  one  byte  hex-value is allowed as pattern, e.g.  if you enter just
  125. one  hex value like '$f' it will be expanded to byte $ff and the memory
  126. will be filled with that value.
  127.  
  128. 'MemClear F -a' will fill the fast-mem area with the char 'a' and won't
  129. clear  a byte in chip memory.  'MemClear FLUSH C -$ff' will first flush
  130. unused stuff from memory and then fill all free chip-mem with hex-value
  131. '$ff' leaving the fast-mem area untouched.
  132.  
  133. -----------------------------------------------------------------------
  134. ===============================  ThanX  ===============================
  135. -----------------------------------------------------------------------
  136.  
  137.        Ralf Thanner  - For all versions of Memclear up till v1.7
  138.  
  139. -----------------------------------------------------------------------
  140. ==============================  History  ==============================
  141. -----------------------------------------------------------------------
  142.  
  143. -----  V2.0  ----------------------------------------------------------
  144.  
  145.        - Removed enforcer hit from clear routine.
  146.        - Removed arp.library support.
  147.        - Some obvious instruction optimisations.
  148.        - Aligned all loops onto 32 bit boundaries.
  149.  
  150. -----------------------------------------------------------------------
  151. ===========================  MemClear V 2.0  ==========================
  152. -----------------------------------------------------------------------
  153.